home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / program / nxdv99_3.zip / LOGFMT.DOC < prev    next >
Text File  |  1996-06-19  |  6KB  |  190 lines
  1.                  Nexus (tm) - Next Epoch matriX User System (tm)
  2.                           Third Party Development Kit
  3.  
  4.  
  5.       (c) Copyright 1996 Intuitive Vision Software.  All Rights Reserved.
  6. ------------------------------------------------------------------------------
  7.  
  8.  
  9. Nexus Log File Structures :  LOGFMT.DOC
  10.  
  11. Revision Number           :  0.99.02
  12. Revision Date             :  19 Jun 96
  13.  
  14.  
  15.  
  16.  
  17.  
  18. Intuitive Vision Software may be in no way held responsible for inaccuracies
  19. of this document with regard to spelling, content, or any other items.  Use
  20. the information contained within at your own risk.  This information with
  21. comes with no guarantee of its accuracy or validity.
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                               Table of Contents
  29.  
  30.  
  31.                         i.     Overview
  32.  
  33.                         ii.    Log File Naming Conventions
  34.  
  35.                         iii.   Log File Format
  36.  
  37.                         iv.    Accessing the Log Files
  38.  
  39.                         v.     Conclusion
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48. i.   Overview
  49.  
  50.  
  51.         Nexus and related Intuitive Vision Software products use a common
  52. log file format so as to promote consistancy for the SysOp running Nexus.
  53. Third Party Developers (TPDs) are required to follow this format if writing
  54. DIRECTLY to the Nexus Log Files and are highly encouraged to do so if
  55. writing to their own log file.
  56.  
  57.  
  58.  
  59.  
  60.  
  61. ii.  Log File Naming Conventions
  62.  
  63.         The Nexus Log Files follow the following naming convention.  You
  64. may choose to implement this if writing to your own TPD-specific log file.
  65. Nexus's Log files are named:
  66.  
  67.         NEXxxxx.LOG     where xxxx is the node number right-justified and
  68.                         padded with zeros. (i.e. NEX0001.LOG for Node 1)
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75. iii. Log File Format
  76.  
  77.         The log file is broken into the following 3 type of lines:  Beginning
  78.         of Day Markers, Beginning of Session Markers, and Log line.  Blank
  79.         lines may be included in log files and will be assumed to be log lines
  80.         as well, though they do not follow the log line format.  They will
  81.         simply be ignored as fillers.
  82.  
  83.  
  84.  
  85.         a. Beginning of Day Markers.
  86.  
  87.                 Beginning of Day Markers look like the following:
  88.  
  89. *** 07/21/95
  90.  
  91.                 The *** is a mark that tells Nexus that a new days log has
  92.                 begun.  This is so that Nexus may delete old logs based on
  93.                 the SysOp's setting in NxSetup.  This entry is required in
  94.                 the Nexus Log Files and is optional in TPD-specific log files.
  95.                 There should only be ONE occurance of a specific date's
  96.                 Beginning of Day Marker.  Use whatever means necessary to
  97.                 ensure that this is followed.  Nexus stores the last date
  98.                 logged in a data file and compares the current date (when
  99.                 starting up) to the last logged date.  If different, it
  100.                 appends a new Beginning of Day Marker.
  101.  
  102.  
  103.         b. Beginning of Session Marker
  104.  
  105.                 Beginning of Session Markers look like the following:
  106.  
  107. --- Created by Nexus 0.97 Alpha [Node 4] On 07/21/95 17:59:54
  108.  
  109.                 There are 2 requirements of the Beginning of Session Marker.
  110.  
  111.                 --- Created by
  112.  
  113.                 is required.
  114.  
  115.                 On 07/21/95 17:59:54
  116.  
  117.                 (i.e. "On [Date] [Time]") is also required.  What a TPD
  118.                 chooses to place in between is entirely up to them.
  119.                 Intuitive Vision Software recommends the Name and Version
  120.                 of the software creating the log entry.
  121.  
  122.  
  123.         c. Log Line
  124.  
  125.                 Log Lines look like the following:
  126.  
  127. : 21:57:37 Begin; Nexus 0.97 Alpha
  128.  
  129.                 Note the positions of the items.  The first item is the
  130.                 Description Character.  This is at position 1.  This is a
  131.                 descriptive character of the type of activity that is
  132.                 being logged.  At this time, Intuitive Vision Software has
  133.                 not decided on a specific format for the Description
  134.                 Characters.  That is left up to the TPD.  Some examples are
  135.                 listed below:
  136.  
  137.                 : Start/End of program
  138.                 ! Error/Extremely Important Information
  139.                 d Running a Door
  140.                 $ Statistics/Information
  141.                 + Adding Something/Information
  142.                 - Removing Something/Information
  143.                 ~ System Activity
  144.  
  145.                 At position 3 the Time of the Log entry is listed.  This
  146.                 MUST be in 24 hour time format.  At position 12 the log line
  147.                 is listed. The log line itself may be of any length.
  148.                 There is no restriction on this matter.  Any information may
  149.                 be listed.  There may be no Color Codes or ANSI sequences in
  150.                 the log file.
  151.  
  152.  
  153.  
  154.  
  155.  
  156. iv.  Accessing the Log Files
  157.  
  158.         Nexus accesses its log files, though they are Text Files, as an
  159. UNTYPED FILE.  This allows Nexus to be able to open the file and share it.
  160. This will allow Third Party Utilities to be able to access the Nexus Log
  161. Files at the same time as Nexus.  You MUST open the Nexus Log Files with
  162. READ/WRITE DENY NONE.  If a TPD is using its own TPD-specific log file, then
  163. that TPD may choose to open the file whichever way serves their purpose best.
  164. When Nexus writes to the log file, it does not keep the log file open.  It
  165. opens the file, writes the necessary lines, and closes the file again.  This
  166. is to ensure that two programs will not write to the file at the same time,
  167. causing garbled log lines.  This COULD happen, but is very unlikely with
  168. this method being employed.
  169.  
  170.  
  171.  
  172.  
  173. v.   Conclusion
  174.  
  175.         Intuitive Vision Software has attempted to set up a unified format
  176. for logging for Nexus and its related software.  This is to allow for ease-
  177. of-use for SysOps.  It is much easier to read a log file that you are familiar
  178. with the format of, than many different log file formats.
  179.  
  180.         If you have any questions regarding the log file format, please
  181. contact Intuitive Vision Software via the means listed in CONTACT.DOC.
  182.  
  183.  
  184.  
  185. Nexus and Next Epoch matriX User System are Trademarks of Intuitive Vision
  186. Software.
  187.  
  188.  
  189. /* End of file LOGFMT.DOC */
  190.